Enviar Documentos para Analises retorno de Score
Enviar documento para gerar o score na API Acertpix via MCP(Model Context Protocol).
Acesse nosso Repositório para integrar MCPs no seu Ambiente de Desenvolvimento
Body
Parâmetro | Descrição | Tipo | Exemplos | Obrigatório |
---|---|---|---|---|
Chave | Campo para identificação da analise | String | "ChaveDefinidaPeloCliente" | Sim |
ImagemFrente | Caminho para o arquivo da ImagemFrente | String | "C:\Pasta\ImagemFrente.png" | Sim |
ImagemVerso | Caminho para o arquivo da ImagemVerso | String | "C:\Pasta\ImagemVerso.png" | Não |
ImagemSelfie | Caminho para o arquivo da ImagemSelfie | String | "C:\Pasta\ImagemSelfie.png" | Não |
ImagemQrCode | Caminho para o arquivo da ImagemQrCode | String | "C:\Pasta\ImagemQrCode.png" | Não |
CPF | CPF para validação em bases cadastrais | String | "000000000000" | Não |
Exemplo de input
envie este documento para gerar o Score, chave ChaveDefinidaPeloCliente, cpf 000000000000, ImagemFrente "C:\Pasta\ImagemFrente.png", ImagemVerso "C:\Pasta\ImagemVerso.png", ImagemSelfie "C:\Pasta\ImagemSelfie.png", ImagemQrCode "C:\Pasta\ImagemQrCode.png"
Status Code 200
Retorno de sucesso.
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Status | Status da requisição | OK = 0, ERRO = 1 | 0 |
Mensagens | Descrição dos erros | String[] | ["SUCESSO"] |
Exemplo
{
"Status": 0,
"Mensagens": [
"SUCESSO"
]
}
Status Code 401
Usuário/Senha inválidos.
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Status | Status da requisição | OK = 0, ERRO = 1 | 1 |
Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Status Code 404
Erro 404 - Url não encontrado
O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.
Status Code 500
Erro não tratado pelo sistema.
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Status | Status da requisição | OK/ERRO | ERRO |
Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Exemplo
{
"Status": "OK",
"Mensagens": [
"string"
]
}